<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::IndexBinaryIVF Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1IndexBinaryIVF-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">faiss::IndexBinaryIVF Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::IndexBinaryIVF:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structfaiss_1_1IndexBinaryIVF.png" usemap="#faiss::IndexBinaryIVF_map" alt=""/>
  <map id="faiss::IndexBinaryIVF_map" name="faiss::IndexBinaryIVF_map">
<area href="structfaiss_1_1IndexBinary.html" alt="faiss::IndexBinary" shape="rect" coords="0,0,131,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a569058430e4b1b81204df1c2cbd3084a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a569058430e4b1b81204df1c2cbd3084a">IndexBinaryIVF</a> (<a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> *<a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">quantizer</a>, size_t <a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>, size_t <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">nlist</a>)</td></tr>
<tr class="separator:a569058430e4b1b81204df1c2cbd3084a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dfe26312102f0010940fd2fbdf87d85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dfe26312102f0010940fd2fbdf87d85"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9dfe26312102f0010940fd2fbdf87d85">reset</a> () override</td></tr>
<tr class="memdesc:a9dfe26312102f0010940fd2fbdf87d85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all elements from the database. <br/></td></tr>
<tr class="separator:a9dfe26312102f0010940fd2fbdf87d85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b4b1ba42e6af7c30ccbaf0fc0f38034"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b4b1ba42e6af7c30ccbaf0fc0f38034"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4b4b1ba42e6af7c30ccbaf0fc0f38034">train</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x) override</td></tr>
<tr class="memdesc:a4b4b1ba42e6af7c30ccbaf0fc0f38034"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trains the quantizer. <br/></td></tr>
<tr class="separator:a4b4b1ba42e6af7c30ccbaf0fc0f38034"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0eb1eca49892304ceaa11bd3a5ffa1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#aaa0eb1eca49892304ceaa11bd3a5ffa1">add</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x) override</td></tr>
<tr class="separator:aaa0eb1eca49892304ceaa11bd3a5ffa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f5fc7b1cc59623154f7922459d8c7bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a8f5fc7b1cc59623154f7922459d8c7bb">add_with_ids</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, const long *xids) override</td></tr>
<tr class="separator:a8f5fc7b1cc59623154f7922459d8c7bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f74afc490b61ba896ecfad037c9a429"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f74afc490b61ba896ecfad037c9a429"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a6f74afc490b61ba896ecfad037c9a429">add_core</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, const long *xids, const long *precomputed_idx)</td></tr>
<tr class="memdesc:a6f74afc490b61ba896ecfad037c9a429"><td class="mdescLeft">&#160;</td><td class="mdescRight">same as add_with_ids, with precomputed coarse quantizer <br/></td></tr>
<tr class="separator:a6f74afc490b61ba896ecfad037c9a429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f33ec7083279f26c0966c5445ec702d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">search_preassigned</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k, const <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *<a class="el" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a>, const int32_t *centroid_dis, int32_t *distances, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels, bool store_pairs, const <a class="el" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> *params=nullptr) const </td></tr>
<tr class="separator:a4f33ec7083279f26c0966c5445ec702d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35ef6b3a56e4a0e258e6944f1a7eedc7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35ef6b3a56e4a0e258e6944f1a7eedc7"></a>
virtual <a class="el" href="structfaiss_1_1BinaryInvertedListScanner.html">BinaryInvertedListScanner</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>get_InvertedListScanner</b> (bool store_pairs=false) const </td></tr>
<tr class="separator:a35ef6b3a56e4a0e258e6944f1a7eedc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf24ee802fe8f43879c735c363b6fd5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#aeaf24ee802fe8f43879c735c363b6fd5">search</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k, int32_t *distances, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels) const override</td></tr>
<tr class="separator:aeaf24ee802fe8f43879c735c363b6fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad233d3fcf4e001849301c0fbeb675f81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">reconstruct</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> key, uint8_t *recons) const override</td></tr>
<tr class="separator:ad233d3fcf4e001849301c0fbeb675f81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a8cd9437b9adc21696aefe1fa440a22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4a8cd9437b9adc21696aefe1fa440a22">reconstruct_n</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> i0, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> ni, uint8_t *recons) const override</td></tr>
<tr class="separator:a4a8cd9437b9adc21696aefe1fa440a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75260a5d45fb24a9a3c3462786f1de4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a75260a5d45fb24a9a3c3462786f1de4d">search_and_reconstruct</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k, int32_t *distances, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels, uint8_t *recons) const override</td></tr>
<tr class="separator:a75260a5d45fb24a9a3c3462786f1de4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0d01c30760152fbac8f08bb5825de4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9e0d01c30760152fbac8f08bb5825de4">reconstruct_from_offset</a> (long list_no, long offset, uint8_t *recons) const </td></tr>
<tr class="separator:a9e0d01c30760152fbac8f08bb5825de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06d0e73e7ece9689000f936e7f1e2960"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06d0e73e7ece9689000f936e7f1e2960"></a>
long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a06d0e73e7ece9689000f936e7f1e2960">remove_ids</a> (const <a class="el" href="structfaiss_1_1IDSelector.html">IDSelector</a> &amp;sel) override</td></tr>
<tr class="memdesc:a06d0e73e7ece9689000f936e7f1e2960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dataset manipulation functions. <br/></td></tr>
<tr class="separator:a06d0e73e7ece9689000f936e7f1e2960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5296e62b0524f13ff66c61fb7db499a2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a5296e62b0524f13ff66c61fb7db499a2">merge_from</a> (<a class="el" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a> &amp;other, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> add_id)</td></tr>
<tr class="separator:a5296e62b0524f13ff66c61fb7db499a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0da8c7c8c73bbc6403845f6a0d8c94db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0da8c7c8c73bbc6403845f6a0d8c94db"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>get_list_size</b> (size_t list_no) const </td></tr>
<tr class="separator:a0da8c7c8c73bbc6403845f6a0d8c94db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280d0a3958664c3eb4164fcb62496b00"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a280d0a3958664c3eb4164fcb62496b00">make_direct_map</a> (bool new_maintain_direct_map=true)</td></tr>
<tr class="separator:a280d0a3958664c3eb4164fcb62496b00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a053815f897da67f2ceefe11f2c6c79fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a053815f897da67f2ceefe11f2c6c79fe"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>replace_invlists</b> (<a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, bool own=false)</td></tr>
<tr class="separator:a053815f897da67f2ceefe11f2c6c79fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:a2a76f22851e42963b6a42c6d39e93b4b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a76f22851e42963b6a42c6d39e93b4b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>IndexBinary</b> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> <a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>=0, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric=METRIC_L2)</td></tr>
<tr class="separator:a2a76f22851e42963b6a42c6d39e93b4b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adec414108d34c63e4a06b6d3f9a3fa35 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#adec414108d34c63e4a06b6d3f9a3fa35">range_search</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, int radius, <a class="el" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result) const </td></tr>
<tr class="separator:adec414108d34c63e4a06b6d3f9a3fa35 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c32414471c57138b248583fc0c5f8c inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels, <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k=1)</td></tr>
<tr class="separator:a27c32414471c57138b248583fc0c5f8c inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d722545b95badd251f3e8770b9bb9b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a63d722545b95badd251f3e8770b9bb9b">display</a> () const </td></tr>
<tr class="separator:a63d722545b95badd251f3e8770b9bb9b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a094ef9572645ff86a76ff4df967bf65a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a094ef9572645ff86a76ff4df967bf65a"></a>
<a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">invlists</a></td></tr>
<tr class="memdesc:a094ef9572645ff86a76ff4df967bf65a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acess to the actual data. <br/></td></tr>
<tr class="separator:a094ef9572645ff86a76ff4df967bf65a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c2b00bd46cb51bf18274b35e43f867d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c2b00bd46cb51bf18274b35e43f867d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>own_invlists</b></td></tr>
<tr class="separator:a8c2b00bd46cb51bf18274b35e43f867d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9890e0946f3aba99ccad6b637df0c8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9890e0946f3aba99ccad6b637df0c8b"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ae9890e0946f3aba99ccad6b637df0c8b">nprobe</a></td></tr>
<tr class="memdesc:ae9890e0946f3aba99ccad6b637df0c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of probes at query time <br/></td></tr>
<tr class="separator:ae9890e0946f3aba99ccad6b637df0c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18ffc5dbf15b4a86a8c868ca845ea4c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18ffc5dbf15b4a86a8c868ca845ea4c9"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a18ffc5dbf15b4a86a8c868ca845ea4c9">max_codes</a></td></tr>
<tr class="memdesc:a18ffc5dbf15b4a86a8c868ca845ea4c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">max nb of codes to visit to do a query <br/></td></tr>
<tr class="separator:a18ffc5dbf15b4a86a8c868ca845ea4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcab702ebe1814ff432401bfd39df492"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#abcab702ebe1814ff432401bfd39df492">use_heap</a> = true</td></tr>
<tr class="separator:abcab702ebe1814ff432401bfd39df492"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ae109b12efeb9b3349c1de2c6d480e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ae109b12efeb9b3349c1de2c6d480e5"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a1ae109b12efeb9b3349c1de2c6d480e5">maintain_direct_map</a></td></tr>
<tr class="memdesc:a1ae109b12efeb9b3349c1de2c6d480e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">map for direct access to the elements. Enables <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">reconstruct()</a>. <br/></td></tr>
<tr class="separator:a1ae109b12efeb9b3349c1de2c6d480e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebfdf003e86fec21e97d8f31a36d4442"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebfdf003e86fec21e97d8f31a36d4442"></a>
std::vector&lt; long &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>direct_map</b></td></tr>
<tr class="separator:aebfdf003e86fec21e97d8f31a36d4442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c08ac8e6c1444e61b9f357cfba34e2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c08ac8e6c1444e61b9f357cfba34e2e"></a>
<a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">quantizer</a></td></tr>
<tr class="memdesc:a5c08ac8e6c1444e61b9f357cfba34e2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">quantizer that maps vectors to inverted lists <br/></td></tr>
<tr class="separator:a5c08ac8e6c1444e61b9f357cfba34e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9eb4370bcc95994822c3a81c290fa919"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9eb4370bcc95994822c3a81c290fa919"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">nlist</a></td></tr>
<tr class="memdesc:a9eb4370bcc95994822c3a81c290fa919"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of possible key values <br/></td></tr>
<tr class="separator:a9eb4370bcc95994822c3a81c290fa919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c7bc3be67d829d49ac1ab2afc4f6b0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c7bc3be67d829d49ac1ab2afc4f6b0c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a2c7bc3be67d829d49ac1ab2afc4f6b0c">own_fields</a></td></tr>
<tr class="memdesc:a2c7bc3be67d829d49ac1ab2afc4f6b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether object owns the quantizer <br/></td></tr>
<tr class="separator:a2c7bc3be67d829d49ac1ab2afc4f6b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c3d371cf3985da70b6dacac74f03491"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c3d371cf3985da70b6dacac74f03491"></a>
<a class="el" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a0c3d371cf3985da70b6dacac74f03491">cp</a></td></tr>
<tr class="memdesc:a0c3d371cf3985da70b6dacac74f03491"><td class="mdescLeft">&#160;</td><td class="mdescRight">to override default clustering params <br/></td></tr>
<tr class="separator:a0c3d371cf3985da70b6dacac74f03491"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4b4048070a6fc5aa3226a2edf42db5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4b4048070a6fc5aa3226a2edf42db5e"></a>
<a class="el" href="structfaiss_1_1Index.html">Index</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ae4b4048070a6fc5aa3226a2edf42db5e">clustering_index</a></td></tr>
<tr class="memdesc:ae4b4048070a6fc5aa3226a2edf42db5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">to override index used during clustering <br/></td></tr>
<tr class="separator:ae4b4048070a6fc5aa3226a2edf42db5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e485a7189eec2675032486d3b12cf88"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a></td></tr>
<tr class="memdesc:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">vector dimension <br/></td></tr>
<tr class="separator:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a277c2645b8def11c5d982384098c5380"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">code_size</a></td></tr>
<tr class="memdesc:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bytes per vector ( = d / 8 ) <br/></td></tr>
<tr class="separator:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41b6759d127475d5fcd2b3982a8f355e"></a>
<a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">ntotal</a></td></tr>
<tr class="memdesc:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">total nb of indexed vectors <br/></td></tr>
<tr class="separator:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1656c00d77d55999becd71e3d8ea6dd7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">verbose</a></td></tr>
<tr class="memdesc:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">verbosity level <br/></td></tr>
<tr class="separator:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a132119ae93e240b54621c5c669853c7f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">is_trained</a></td></tr>
<tr class="memdesc:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">set if the <a class="el" href="structfaiss_1_1Index.html">Index</a> does not require training, or if training is done already <br/></td></tr>
<tr class="separator:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a344529c829717012b530ef9c13b145b7"></a>
<a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">metric_type</a></td></tr>
<tr class="memdesc:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of metric this index uses for search <br/></td></tr>
<tr class="separator:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:a01749bbdbd3b7ec6bb9390257ab16c5c inherit pub_types_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01749bbdbd3b7ec6bb9390257ab16c5c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> = <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a></td></tr>
<tr class="memdesc:a01749bbdbd3b7ec6bb9390257ab16c5c inherit pub_types_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">all indices are this type <br/></td></tr>
<tr class="separator:a01749bbdbd3b7ec6bb9390257ab16c5c inherit pub_types_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0f338d22575d508cd6141972addaa6 inherit pub_types_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0f338d22575d508cd6141972addaa6"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>component_t</b> = uint8_t</td></tr>
<tr class="separator:aaa0f338d22575d508cd6141972addaa6 inherit pub_types_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af958aa9b51dac1fcc433014959cad20c inherit pub_types_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af958aa9b51dac1fcc433014959cad20c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>distance_t</b> = int32_t</td></tr>
<tr class="separator:af958aa9b51dac1fcc433014959cad20c inherit pub_types_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structfaiss_1_1Index.html">Index</a> based on a inverted file (IVF)</p>
<p>In the inverted file, the quantizer (an <a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> instance) provides a quantization index for each vector to be added. The quantization index maps to a list (aka inverted list or posting list), where the id of the vector is stored.</p>
<p>Otherwise the object is similar to the <a class="el" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> </p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8h_source.html#l00035">35</a> of file <a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a569058430e4b1b81204df1c2cbd3084a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">faiss::IndexBinaryIVF::IndexBinaryIVF </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> *&#160;</td>
          <td class="paramname"><em>quantizer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>nlist</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The Inverted file takes a quantizer (an <a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a>) on input, which implements the function mapping a vector to a list identifier. The pointer is borrowed: the quantizer should not be deleted while the <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a> is in use. </p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00026">26</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aaa0eb1eca49892304ceaa11bd3a5ffa1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Add n vectors of dimension d to the index.</p>
<p>Vectors are implicitly assigned labels ntotal .. ntotal + n - 1 </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>input matrix, size n * d / 8 </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="structfaiss_1_1IndexBinary.html#af04b1093cdebfea189e0e04da68794d7">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00056">56</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8f5fc7b1cc59623154f7922459d8c7bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::add_with_ids </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const long *&#160;</td>
          <td class="paramname"><em>xids</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Same as add, but stores xids instead of sequential ids.</p>
<p>The default implementation fails with an assertion, as it is not supported by all indexes.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xids</td><td>if non-null, ids to store for the vectors (size n) </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexBinary.html#a68a24abdf241eb98372b7d6fbd8d3891">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00060">60</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a280d0a3958664c3eb4164fcb62496b00"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::make_direct_map </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>new_maintain_direct_map</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>intialize a direct map</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">new_maintain_direct_map</td><td>if true, create a direct map, else clear it </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00104">104</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a5296e62b0524f13ff66c61fb7db499a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::merge_from </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>add_id</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>moves the entries from another dataset to self. On output, other is empty. add_id is added to all moved ids (for sequential ids, this would be this-&gt;ntotal </p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00292">292</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad233d3fcf4e001849301c0fbeb675f81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::reconstruct </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>recons</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reconstruct a stored vector.</p>
<p>This function may not be defined for some indexes. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>id of the vector to reconstruct </td></tr>
    <tr><td class="paramname">recons</td><td>reconstucted vector (size d / 8) </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexBinary.html#a60180e1c6b363c287b6e55191455a82f">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00144">144</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a9e0d01c30760152fbac8f08bb5825de4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::reconstruct_from_offset </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>list_no</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>recons</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reconstruct a vector given the location in terms of (inv list index + inv list offset) instead of the id.</p>
<p>Useful for reconstructing when the direct_map is not maintained and the inv list offset is computed by <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">search_preassigned()</a> with <code>store_pairs</code> set. </p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00206">206</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4a8cd9437b9adc21696aefe1fa440a22"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::reconstruct_n </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>i0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>ni</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>recons</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reconstruct a subset of the indexed vectors.</p>
<p>Overrides default implementation to bypass <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">reconstruct()</a> which requires direct_map to be maintained.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i0</td><td>first vector to reconstruct </td></tr>
    <tr><td class="paramname">ni</td><td>nb of vectors to reconstruct </td></tr>
    <tr><td class="paramname">recons</td><td>output array of reconstructed vectors, size ni * d / 8 </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexBinary.html#ab5885ba0cbd91cf6c5fe2f53bb5650c3">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00152">152</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aeaf24ee802fe8f43879c735c363b6fd5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::search </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>distances</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *&#160;</td>
          <td class="paramname"><em>labels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>assign the vectors, then call search_preassign </p>

<p>Implements <a class="el" href="structfaiss_1_1IndexBinary.html#a48cdd06037d1fb8ce827e7522ba05fb8">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00127">127</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a75260a5d45fb24a9a3c3462786f1de4d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::search_and_reconstruct </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>distances</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *&#160;</td>
          <td class="paramname"><em>labels</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>recons</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Similar to search, but also reconstructs the stored vectors (or an approximation in the case of lossy coding) for the search results.</p>
<p>Overrides default implementation to avoid having to maintain direct_map and instead fetch the code offsets through the <code>store_pairs</code> flag in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">search_preassigned()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">recons</td><td>reconstructed vectors size (n, k, d / 8) </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexBinary.html#ae99e8745fc02ffac2cfdb431951eeabf">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00171">171</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4f33ec7083279f26c0966c5445ec702d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryIVF::search_preassigned </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a>&#160;</td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *&#160;</td>
          <td class="paramname"><em>assign</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int32_t *&#160;</td>
          <td class="paramname"><em>centroid_dis</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>distances</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *&#160;</td>
          <td class="paramname"><em>labels</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>store_pairs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> *&#160;</td>
          <td class="paramname"><em>params</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Search a set of vectors, that are pre-quantized by the IVF quantizer. Fill in the corresponding heaps with the query results. <a class="el" href="structfaiss_1_1IndexBinaryIVF.html#aeaf24ee802fe8f43879c735c363b6fd5">search()</a> calls this.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">n</td><td>nb of vectors to query </td></tr>
    <tr><td class="paramname">x</td><td>query vectors, size nx * d </td></tr>
    <tr><td class="paramname">assign</td><td>coarse quantization indices, size nx * nprobe </td></tr>
    <tr><td class="paramname">centroid_dis</td><td>distances to coarse centroids, size nx * nprobe </td></tr>
    <tr><td class="paramname">distance</td><td>output distances, size n * k </td></tr>
    <tr><td class="paramname">labels</td><td>output labels, size n * k </td></tr>
    <tr><td class="paramname">store_pairs</td><td>store inv list index + inv list offset instead in upper/lower 32 bit of result, instead of ids (used for reranking). </td></tr>
    <tr><td class="paramname">params</td><td>used to override the object's search parameters </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8cpp_source.html#l00637">637</a> of file <a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abcab702ebe1814ff432401bfd39df492"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool faiss::IndexBinaryIVF::use_heap = true</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Select between using a heap or counting to select the k smallest values when scanning inverted lists. </p>

<p>Definition at line <a class="el" href="IndexBinaryIVF_8h_source.html#l00046">46</a> of file <a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="IndexBinaryIVF_8cpp_source.html">IndexBinaryIVF.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
